Scriptable Reports

ControlHost

Page Interface Structure

The interface used by custom controls to interact with the report.

Methods

back()

Go back one prompt page.

cancel()

Cancel report execution.

finish()

Submit parameter values and skip all remaining optional prompts and prompt pages.

getParameter(sParameter) → {Array.<Parameter>|Array.<RangeParameter>}

Called to get the current value of a parameter.
Parameters:
Name Type Description
sParameter String The parameter name.
Returns:
A parameter.
Type
Array.<Parameter> | Array.<RangeParameter>

next()

Submit parameter values and go to the next prompt page.

reprompt()

If the report contains prompt pages, the first prompt page is displayed. Otherwise, if the report doesn't contain prompt pages, this will re-prompt for values.

validStateChanged()

Called to notify the ControlHost that the valid state of the control has changed.

valueChanged()

Called to notify the ControlHost that a value has change.
Example
C_HtmlSelect.prototype.onSelectChange = function( oControlHost )
{
	oControlHost.valueChanged();
};